@thallylabs/migrate 0.2.8 → 0.2.10

package/dist/index.d.ts

@@ -41,13 +41,24 @@ interface MigrationNavbarConfig {
         href: string;
         type?: 'github';
     }>;
+    /** Explicit null suppresses the starter's sample call to action. */
     primary?: {
         label: string;
         href: string;
-    };
+    } | null;
+    /** Local public assets used until an owner uploads a brand replacement. */
+    /** Explicit null requests a text-only brand when the source has no logo. */
+    logo?: {
+        light: string;
+        dark?: string;
+        showTitle?: boolean;
+        rightText?: string;
+    } | null;
 }
 interface MigrationFooterConfig {
     socials?: Record<string, string>;
+    /** Literal footer attribution; `{year}` is resolved by the site at render time. */
+    copyright?: string;
     links?: Array<{
         heading: string;
         items: Array<{
@@ -66,12 +77,25 @@ interface MigrationDocsConfig {
         display?: 'tabs' | 'dropdown';
     };
     theme?: 'default' | 'maple' | 'sharp' | 'minimal';
+    appearance?: {
+        default?: 'system' | 'light' | 'dark';
+        showToggle?: boolean;
+    };
+    background?: {
+        image?: string;
+        imageDark?: string;
+        decoration?: 'none' | 'grid' | 'gradient';
+    };
     /** Icon set for content `icon` names; Mintlify's `icons.library` carries through. */
     icons?: {
         library?: 'lucide' | 'fontawesome' | 'tabler';
     };
     banner?: MigrationBannerConfig;
     navbar?: MigrationNavbarConfig;
+    favicon?: {
+        light: string;
+        dark?: string;
+    };
     footer?: MigrationFooterConfig;
     seo?: {
         indexing?: 'navigable' | 'all';
@@ -111,6 +135,8 @@ interface MigrationDocsConfig {
             code: string;
             label: string;
         }>;
+        /** Source-authored navigation labels and ordering for each translation. */
+        navigation?: Record<string, Array<MigrationNavigationTab>>;
     };
 }
 interface MigrationPage {
@@ -122,6 +148,8 @@ interface MigrationPage {
     title: string;
     navTitle?: string;
     description: string;
+    /** Keep SEO/search description without repeating it above Docusaurus body copy. */
+    descriptionPlacement?: 'body';
     badge?: string;
     keywords: Array<string>;
     mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
@@ -148,6 +176,11 @@ interface MigrationBundle {
     platform: MigrationPlatform;
     pages: Array<MigrationPage>;
     assets: Array<MigrationAsset>;
+    /** Repository-configured remote specs awaiting a bounded network fetch by the host. */
+    remoteApiSpecs?: Array<{
+        url: string;
+        tabLabel?: string;
+    }>;
     /** Customer-owned component source and registry; paths are repository-relative. */
     componentFiles?: Array<RenderedMigrationFile>;
     docsConfig: MigrationDocsConfig;
@@ -312,6 +345,10 @@ interface FernPageDescriptor {
     /** Path to the referenced page file, relative to the Fern root. */
     sourcePath: string;
     navigationId: string;
+    /** Fern's sidebar label can intentionally differ from the page title. */
+    navTitle?: string;
+    /** Keep routable pages excluded by Fern's `hidden` navigation flag. */
+    hidden?: boolean;
 }
 /** One `api:` navigation node, resolved to the name/tab Thally needs to bind its spec. */
 interface FernApiSection {
@@ -337,6 +374,11 @@ interface FernNavigationResult {
     warnings: Array<MigrationWarning>;
     /** Every `api:` node found in navigation, in document order. A repo can declare several (e.g. a REST and a WebSocket API in separate tabs). */
     apiSections: Array<FernApiSection>;
+    /** Fern changelog tabs render their entries as a feed at the bare route. */
+    changelogIndexes: Array<{
+        route: string;
+        entries: Array<string>;
+    }>;
 }
 /** Read `fern/docs.yml` without executing anything. */
 declare function readFernConfig(fernRoot: string): {
@@ -404,4 +446,11 @@ declare const defaultMigrationFetcher: MigrationFetcher;
 /** Crawl one public docs origin into a canonical, caller-independent bundle. */
 declare function migrateUrl(options: UrlMigrationOptions): Promise<MigrationBundle>;
 
-export { type GitHubRepositorySource, type MigrationAsset, type MigrationBundle, type MigrationDocsConfig, type MigrationFetchRequest, type MigrationFetchResponse, type MigrationFetcher, type MigrationNavigationGroup, type MigrationNavigationTab, type MigrationPage, type MigrationPlatform, type MigrationWarning, type RenderedMigrationFile, type RepositoryMigrationOptions, type UrlMigrationOptions, addMintlifyDirectoryRedirects, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, gitmodulePaths, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectFernNavigation, projectMintlifyNavigation, pruneMissingNavigationPages, readFernConfig, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };
+/**
+ * Attach safely downloaded specs to the exact authored API tabs. Source links
+ * to Mintlify's tag/summary routes receive redirects only when an operation
+ * can be identified uniquely; guessing would silently route to wrong APIs.
+ */
+declare function hydrateRemoteApiSpecs(bundle: MigrationBundle, fetcher?: MigrationFetcher): Promise<MigrationBundle>;
+
+export { type GitHubRepositorySource, type MigrationAsset, type MigrationBundle, type MigrationDocsConfig, type MigrationFetchRequest, type MigrationFetchResponse, type MigrationFetcher, type MigrationNavigationGroup, type MigrationNavigationTab, type MigrationPage, type MigrationPlatform, type MigrationWarning, type RenderedMigrationFile, type RepositoryMigrationOptions, type UrlMigrationOptions, addMintlifyDirectoryRedirects, buildNavigationFromPages, cloneGitHubRepository, defaultMigrationFetcher, detectRepositoryDocsDir, detectRepositoryPlatform, gitmodulePaths, hydrateRemoteApiSpecs, mergeMigrationConfig, migrateRepository, migrateUrl, normalizeMdx, parseGitHubRepositoryUrl, parseMarkdownPage, projectFernNavigation, projectMintlifyNavigation, pruneMissingNavigationPages, readFernConfig, readMintlifyConfig, renderMigrationFiles, validateMigrationUrl };